docs(seqera-ai): align Enterprise Co-Scientist docs for 26.1#1381
docs(seqera-ai): align Enterprise Co-Scientist docs for 26.1#1381llewellyn-sl wants to merge 13 commits into
Conversation
✅ Deploy Preview for seqera-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
| ```bash | ||
| export SEQERA_AUTH_DOMAIN=https://cloud.seqera.io/api | ||
| export SEQERA_AUTH_DOMAIN=https://platform.example.com/api | ||
| export SEQERA_AUTH_CLI_CLIENT_ID=seqera_ai_cli |
There was a problem hiding this comment.
| export SEQERA_AUTH_CLI_CLIENT_ID=seqera_ai_cli |
this doesn't seem to be needed
There was a problem hiding this comment.
I added these 4 to my shell when trying to get the CLI working. TBD if they were all necessary:
- `SEQERA_AI_BACKEND_URL`
- `SEQERA_AUTH_DOMAIN`
- `SEQERA_AUTH_CLI_CLIENT_ID`
- `TOWER_ACCESS_TOKEN`
gwright99
left a comment
There was a problem hiding this comment.
Commented on the parts of this PR which touched upon deployment. I did not review the "how to use the CLI" since this was not part of my efforts last week.
| - **Token encryption key** for encrypting sensitive tokens at rest. Generate with: | ||
| - Seqera Platform Enterprise 26.1 or later deployed with the [Seqera Platform Helm chart](./platform-helm.md). | ||
| - Helm v3 and `kubectl` installed locally. | ||
| - DNS names and TLS certificates for the Platform, agent backend, MCP server, and portal web interface hosts. |
There was a problem hiding this comment.
If created manually, where are they getting the FQDNs from? Having to look at the Helm chart config?
239f207 to
403a157
Compare
e7df482 to
3fb137d
Compare
bebosudo
left a comment
There was a problem hiding this comment.
Some initial recommendations, I've got some more coming up
Co-authored-by: Alberto Chiusole <1922124+bebosudo@users.noreply.github.com> Signed-off-by: Justine Geffen <justinegeffen@users.noreply.github.com>
Co-authored-by: Alberto Chiusole <1922124+bebosudo@users.noreply.github.com> Signed-off-by: Justine Geffen <justinegeffen@users.noreply.github.com>
Co-authored-by: Alberto Chiusole <1922124+bebosudo@users.noreply.github.com> Signed-off-by: Justine Geffen <justinegeffen@users.noreply.github.com>
Co-authored-by: Alberto Chiusole <1922124+bebosudo@users.noreply.github.com> Signed-off-by: Justine Geffen <justinegeffen@users.noreply.github.com>
|
fix formatting |
| value: "false" | ||
| ``` | ||
|
|
||
| Documentation search embeddings are independent from chat inference. Keep Titan embeddings configured through Bedrock when you use improved documentation search. |
There was a problem hiding this comment.
Adding this note here as a reminder to update the docs after we update the helm charts and define the inference provider and documentation index user-interface (i.e. there should be no need to specify values via extraEnvVars). cc @endre-seqera
| Configure Bedrock so Claude inference and Titan embeddings run in your AWS account. Bedrock is the recommended Enterprise configuration. | ||
|
|
||
| ```yaml | ||
| agent-backend: |
There was a problem hiding this comment.
I'm not sure specifying agent-backend may be misleading to users, and I need to test what happens when the same map is specified multiple times, does it augment the previous one or overwrite it?
| enabled: true | ||
| ``` | ||
|
|
||
| Expose MCP, agent backend, and portal web through the chart ingress only if you use Kubernetes Ingress. If you use the Gateway API or another network layer, configure that layer instead. |
There was a problem hiding this comment.
This sentence should go at the top of the document probably, and made less redundant possibly, something like "The MCP, agent backend and portal web Helm charts provide the option to define kubernetes ingresses: other methods to expose the services can be used, e.g. via the extraDeploy resource".
|
|
||
| Enterprise deployments do not use Seqera Cloud credit balances or the Cloud credit request flow. Usage and inference costs are managed by your organization through the configured inference provider, such as AWS Bedrock or Anthropic API. | ||
|
|
||
| When `ORG_CREDITS_ENABLED=false` is set on the agent backend deployment, the CLI `/credits` command reports that usage is managed by your organization and directs users to their Seqera administrator. |
There was a problem hiding this comment.
I want to bring this value into the helm chart if it's important to enterprise customers so they won't need to play with extraEnvVars
There was a problem hiding this comment.
this is now set to false for the new builds, let's remove it
| When `ORG_CREDITS_ENABLED=false` is set on the agent backend deployment, the CLI `/credits` command reports that usage is managed by your organization and directs users to their Seqera administrator. |
|
Should we add https://docs.seqera.io/platform-enterprise/seqera-ai/prerequisites to the LHS in this PR? @gavinelder, @odagayev? |
Co-authored-by: Alberto Chiusole <1922124+bebosudo@users.noreply.github.com> Signed-off-by: Justine Geffen <justinegeffen@users.noreply.github.com>
Co-authored-by: Alberto Chiusole <1922124+bebosudo@users.noreply.github.com> Signed-off-by: Justine Geffen <justinegeffen@users.noreply.github.com>
Co-authored-by: Alberto Chiusole <1922124+bebosudo@users.noreply.github.com> Signed-off-by: Justine Geffen <justinegeffen@users.noreply.github.com>
Co-authored-by: Alberto Chiusole <1922124+bebosudo@users.noreply.github.com> Signed-off-by: Justine Geffen <justinegeffen@users.noreply.github.com>
Co-authored-by: Alberto Chiusole <1922124+bebosudo@users.noreply.github.com> Signed-off-by: Justine Geffen <justinegeffen@users.noreply.github.com>
Signed-off-by: Justine Geffen <justinegeffen@users.noreply.github.com>
Summary
Validation
git diff --checkplatform-enterprise_docs/enterprise-sidebar.jsonNotes